home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / irsuser1.arc / IRSUSER.DOC < prev    next >
Text File  |  1991-04-28  |  8KB  |  178 lines
  1.               /*      IRSUSER.C V1.0 beta April 22, 1991      */
  2.               /* Copyright (c) 1991 David Boyd and Joe Dargie */
  3.  
  4.               /* Tested and compatible with PCBoard 14.5a beta*/
  5.  
  6.               /* Source may be modified but can not be used   */
  7.               /* in any commercial environment for profit     */
  8.               /* without prior permission from David Boyd     */
  9.               /* and Joe Dargie                               */
  10.  
  11.               /* Support/suggestions/complaints can be made   */
  12.               /* via modem at (401) 539-8636 24 hours/day     */
  13.               /* 7 days/week-The Information Resource System  */
  14.  
  15. Table of Contents...
  16.  
  17.         Table of Contents.......................................page i
  18.         What this program does?.................................page 1
  19.         Why did I write it and how much does it cost?...........page 1
  20.         Who am I?...............................................page 1
  21.         Who actually wrote IRSUSER?.............................page 1
  22.         How do you use IRSUSER?.................................page 2
  23.         What else is there you need to know?....................page 2
  24.         Obligations and promises................................page 3
  25.         Legal mumbo-jumbo.......................................page 3
  26.  
  27.  
  28.         This document is totally unnecessary!  Simply type the name of
  29.         the program - IRSUSER - and a screen will appear giving you the
  30.         necessary command line parameters and syntax.  I've only
  31.         included this document because, if you're like me, you like to
  32.         RTFM and get to know something about the programmer behind the
  33.         program!  If this is the first time you've used IRSUSER then
  34.         just make a backup copy of your PCBoard USERS file and use the
  35.         backup copy - NOT YOUR ORIGINAL.  The original file sizes and
  36.         dates included in this distribution file is in a file called
  37.         IRSFILES.DOC in order to ease your worries (although a couple
  38.         Michelob Dry's would probably do just as well).
  39.         IRSHIST.DOC is included for your curiosity's sake.
  40.  
  41.         PCBoard is a registered trademark of Clark Development Company, Inc.
  42.         Turbo C is a registered trademark of Borland International, Inc.
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.                                    <page i>
  56. What this program does...
  57.  
  58.         IRSUSER.EXE will read your PCBoard 14.5a USERS file (it will
  59.         never *write* to this file) and audit all users with a
  60.         specific security level and then check to see if their
  61.         expiration date has expired.
  62.  
  63.         It then creates a file (which can be used as a bulletin) with
  64.         the names of all successfull matches and the expired user's name
  65.         will be in lower case while the non-expired user's name will be
  66.         in upper case (hey, rank does have it's privileges!).
  67.  
  68. Why did I write it and how much does it cost?...
  69.  
  70.         I wanted a way to search my PCBoard USERS file and create a
  71.         list of names of callers that were a specific security level.
  72.         I use this file for a bulletin and maintain it daily during
  73.         my BBS's daily maintenance event.  Simple, huh?!
  74.  
  75.         The program COSTS NOTHING and is being uploaded into the great
  76.         world of Public Domain software!  All I ask is that no-one try
  77.         to use it commercially to make a profit from it.  If you want to
  78.         send me something please send a message with your comments,
  79.         likes, dis-likes, and any enhancements you can think of.  I
  80.         won't make any promises to include all enhancements but I do
  81.         promise to handle likes and dis-likes appropriately!
  82.  
  83. Who am I?...
  84.  
  85.         If you're like me, before I run any program I like to know who
  86.         the person is that wrote it.  My name is Joe Dargie and I'm the
  87.         Sysop of The Information Resource System BBS (The IRS BBS).
  88.         I'm a member of the ILink mail network and can be reached in the
  89.         ILink Sysop conference or on my BBS (300-9600 baud USR HST soon
  90.         to be Dual Standard).
  91.  
  92.                                 The I.R.S. BBS
  93.                                     Box 606
  94.                               Carolina, RI 02812
  95.                                 (401) 539-8636
  96.  
  97. Who actually wrote IRSUSER?...
  98.  
  99.         Well, I started it but it was mainly written by my Co-Sysop
  100.         David Boyd.  I'm just beginning to learn programming and decided
  101.         to start with the 'C' programming language.  I asked David a few
  102.         questions and he turned around and gave me examples of code
  103.         which wound up being the entire program.  With my suggestions
  104.         and a few modifications we worked on IRSUSER together.  Dave
  105.         created most of the code while I watched, er, helped and wrote
  106.         the documentation.  I took several classes in 'C' programming but
  107.         learned more from David than any book or instructor.  Thanks Dave!
  108.  
  109.  
  110.                                    <page 1>
  111. How do you use IRSUSER?...
  112.  
  113.         IRSUSER is meant to be used during a system maintenance event.
  114.         It is command line driven and the syntax is as follows:
  115.  
  116. IRSUSER.EXE Users_file Bulletin_file Security_level [title.ext] [caption.ext]
  117.  
  118.         where...
  119.  
  120.         IRSUSER.EXE is the name of the executable program
  121.         Users_file is the full path and name of your PCBoard USERS file
  122.         Bulletin_file is the full path and name of the text file which
  123.                     is to be created
  124.         Security_level is an integer from 1-255 representing the
  125.                     security level you wish to search for
  126.         [title.ext] is an optional text file which you create and is
  127.                     placed at the top of the Bulletin_file
  128.         [caption.ext] is an optional text file which you create and is
  129.                     placed at the end of the Bulletin_file
  130.  
  131.         Both [title.ext] and [caption.ext] are optional and need not be
  132.         included (it will default to my I.R.S title and caption).  All
  133.         other command line parameters are mandatory and must be placed
  134.         in the position's as shown above.
  135.  
  136.         You can see a brief explanation of the above by simply running
  137.         IRSUSER.EXE without any command line parameters.
  138.  
  139.         How much memory it uses is unknown but I have run it in as little 
  140.         as 145K RAM.  You will need to insure that you have enough disk
  141.         space to handle the file which is created.  With my simple title
  142.         and caption screens and about 50 names it takes about 2K of disk
  143.         space.
  144.  
  145. What else is there you need to know?...
  146.  
  147.         It's pretty simple and straightforward.  The program was written
  148.         using Turbo C 2.01.  The only other thing you may wish to know
  149.         is the exit codes which are:
  150.  
  151.         Errorlevel 0  - Successfully executed with no errors
  152.         Errorlevel 1  - Can't find the Users_file
  153.         Errorlevel 2  - Can't create the Bulletin_file
  154.         Errorlevel 3  - Can't interpret the Security_level
  155.         Errorlevel 4  - Can't find the [title.ext] 
  156.         Errorlevel 5  - Can't find the [caption.ext]
  157.         Errorlevel 99 - No command line parameters were given
  158.  
  159.         The program only takes about 4 seconds to process a USERS file
  160.         containing approximately 500 names using an Acer 1100 386/16mhz
  161.         or 12 seconds using an 80286/10mhz clone.
  162.  
  163.  
  164.  
  165.                                    <page 2>
  166. Obligations and promises...
  167.  
  168.         <This space intentionally left blank>
  169.  
  170. Legal mumbo-jumbo...
  171.  
  172.         Use this program at your own risk.  You assume all liabilities
  173.         and responsibilities regarding the use and operation of this 
  174.         program and any effects it may have.  Sorry, but for the price
  175.         we're charging for it we can't afford a lawyer!
  176.  
  177.                                    <page 3>
  178.